Open
Conversation
mkistler
approved these changes
Oct 30, 2022
mkistler
left a comment
mkistler
left a comment
There was a problem hiding this comment.
Looks good. 👍
I left some suggestions to change/remove material that seems only applicable to protobuf, but I would be okay with merging the PR as is and addressing this points later.
Comment on lines
+95
to
+110
| ### Internal comments | ||
|
|
||
| <!-- TODO: This does not work outside of Google. | ||
| We should probably try to get that fixed. --> | ||
|
|
||
| Comments **may** be explicitly marked as internal by wrapping internal content | ||
| in `(--` and `--)`. | ||
|
|
||
| Non-public links, internal implementation notes (such as `TODO` and `FIXME` | ||
| directives), and other such material **must** be marked as internal. | ||
|
|
||
| **Note:** In IDLs using code comment syntax, comments **should** use only | ||
| leading comments (not trailing comments or detached comments). In particular, | ||
| comments **must not** use both a leading and trailing comment to describe any | ||
| component, because this is a common source of inadvertent omissions of the | ||
| internal content annotation. |
There was a problem hiding this comment.
Suggest that we remove this -- it apparently doesn't work outside Google and there is no OAS analog.
|
|
||
| ## Guidance | ||
|
|
||
| In APIs defined in protocol buffers, public comments **must** be included over |
There was a problem hiding this comment.
Let's not restrict this to protocol buffers.
Suggested change
| In APIs defined in protocol buffers, public comments **must** be included over | |
| Documentation **must** be included for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.